

<!DOCTYPE html>


<html lang="en" >

  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

    <title>Class engine &#8212; libf3d 2.5.1 documentation</title>
  
  
  
  <script data-cfasync="false">
    document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
    document.documentElement.dataset.theme = localStorage.getItem("theme") || "light";
  </script>
  
  <!-- Loaded before other Sphinx assets -->
  <link href="../_static/styles/theme.css?digest=12da95d707ffb74b382d" rel="stylesheet" />
<link href="../_static/styles/bootstrap.css?digest=12da95d707ffb74b382d" rel="stylesheet" />
<link href="../_static/styles/pydata-sphinx-theme.css?digest=12da95d707ffb74b382d" rel="stylesheet" />

  
  <link href="../_static/vendor/fontawesome/6.1.2/css/all.min.css?digest=12da95d707ffb74b382d" rel="stylesheet" />
  <link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-solid-900.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2" />

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" href="../_static/styles/sphinx-book-theme.css?digest=14f4ca6b54d191a8c7657f6c759bf11a5fb86285" type="text/css" />
    <link rel="stylesheet" type="text/css" href="../_static/collapsible-lists/css/tree_view.css" />
  
  <!-- Pre-loaded scripts that we'll load fully later -->
  <link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=12da95d707ffb74b382d" />
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=12da95d707ffb74b382d" />

    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
    <script src="../_static/jquery.js"></script>
    <script src="../_static/underscore.js"></script>
    <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
    <script src="../_static/doctools.js"></script>
    <script src="../_static/sphinx_highlight.js"></script>
    <script src="../_static/scripts/sphinx-book-theme.js?digest=5a5c038af52cf7bc1a1ec88eea08e6366ee68824"></script>
    <script src="../_static/collapsible-lists/js/CollapsibleLists.compressed.js"></script>
    <script src="../_static/collapsible-lists/js/apply-collapsible-lists.js"></script>
    <script>DOCUMENTATION_OPTIONS.pagename = 'api/classf3d_1_1engine';</script>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="Class exception" href="class_structf3d_1_1exception.html" />
    <link rel="prev" title="Class context" href="classf3d_1_1context.html" />
  <meta name="viewport" content="width=device-width, initial-scale=1"/>
  <meta name="docsearch:language" content="en"/>
  </head>
  
  
  <body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">

  
  
  <a class="skip-link" href="#main-content">Skip to main content</a>
  
  <input type="checkbox"
          class="sidebar-toggle"
          name="__primary"
          id="__primary"/>
  <label class="overlay overlay-primary" for="__primary"></label>
  
  <input type="checkbox"
          class="sidebar-toggle"
          name="__secondary"
          id="__secondary"/>
  <label class="overlay overlay-secondary" for="__secondary"></label>
  
  <div class="search-button__wrapper">
    <div class="search-button__overlay"></div>
    <div class="search-button__search-container">
<form class="bd-search d-flex align-items-center"
      action="../search.html"
      method="get">
  <i class="fa-solid fa-magnifying-glass"></i>
  <input type="search"
         class="form-control"
         name="q"
         id="search-input"
         placeholder="Search..."
         aria-label="Search..."
         autocomplete="off"
         autocorrect="off"
         autocapitalize="off"
         spellcheck="false"/>
  <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form></div>
  </div>
  
    <nav class="bd-header navbar navbar-expand-lg bd-navbar">
    </nav>
  
  <div class="bd-container">
    <div class="bd-container__inner bd-page-width">
      
      <div class="bd-sidebar-primary bd-sidebar">
        

  
  <div class="sidebar-header-items sidebar-primary__section">
    
    
    
    
  </div>
  
    <div class="sidebar-primary-items__start sidebar-primary__section">
        <div class="sidebar-primary-item">
  

<a class="navbar-brand logo" href="../index.html">
  
  
  
  
  
    <p class="title logo__title">libf3d 2.5.1 documentation</p>
  
</a></div>
        <div class="sidebar-primary-item"><nav class="bd-links" id="bd-docs-nav" aria-label="Main">
    <div class="bd-toc-item navbar-nav active">
        <p aria-level="2" class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current nav bd-sidenav">
<li class="toctree-l1 current active has-children"><a class="reference internal" href="library_root.html">Library API</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="namespace_f3d.html">Namespace f3d</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1camera__state__t.html">Struct camera_state_t</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1context_1_1loading__exception.html">Struct context::loading_exception</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1context_1_1symbol__exception.html">Struct context::symbol_exception</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1engine_1_1cache__exception.html">Struct engine::cache_exception</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1engine_1_1libInformation.html">Struct engine::libInformation</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1engine_1_1no__interactor__exception.html">Struct engine::no_interactor_exception</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1engine_1_1no__window__exception.html">Struct engine::no_window_exception</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1engine_1_1plugin__exception.html">Struct engine::plugin_exception</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1engine_1_1readerInformation.html">Struct engine::readerInformation</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1image_1_1metadata__exception.html">Struct image::metadata_exception</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1image_1_1read__exception.html">Struct image::read_exception</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1image_1_1write__exception.html">Struct image::write_exception</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1interaction__bind__t.html">Struct interaction_bind_t</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1interactor_1_1already__exists__exception.html">Struct interactor::already_exists_exception</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1interactor_1_1command__runtime__exception.html">Struct interactor::command_runtime_exception</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1interactor_1_1does__not__exists__exception.html">Struct interactor::does_not_exists_exception</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1mesh__t.html">Struct mesh_t</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1point3__t.html">Struct point3_t</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1scene_1_1load__failure__exception.html">Struct scene::load_failure_exception</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1utils_1_1string__template_1_1lookup__error.html">Struct string_template::lookup_error</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1utils_1_1tokenize__exception.html">Struct utils::tokenize_exception</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1vector3__t.html">Struct vector3_t</a></li>
<li class="toctree-l2"><a class="reference internal" href="classf3d_1_1camera.html">Class camera</a></li>
<li class="toctree-l2"><a class="reference internal" href="classf3d_1_1context.html">Class context</a></li>
<li class="toctree-l2 current active"><a class="current reference internal" href="#">Class engine</a></li>
<li class="toctree-l2"><a class="reference internal" href="class_structf3d_1_1exception.html">Class exception</a></li>
<li class="toctree-l2"><a class="reference internal" href="classf3d_1_1image.html">Class image</a></li>
<li class="toctree-l2"><a class="reference internal" href="classf3d_1_1interactor.html">Class interactor</a></li>
<li class="toctree-l2"><a class="reference internal" href="classf3d_1_1log.html">Class log</a></li>
<li class="toctree-l2"><a class="reference internal" href="classf3d_1_1ratio__t.html">Class ratio_t</a></li>
<li class="toctree-l2"><a class="reference internal" href="classf3d_1_1scene.html">Class scene</a></li>
<li class="toctree-l2"><a class="reference internal" href="classf3d_1_1utils.html">Class utils</a></li>
<li class="toctree-l2"><a class="reference internal" href="classf3d_1_1utils_1_1string__template.html">Class utils::string_template</a></li>
<li class="toctree-l2"><a class="reference internal" href="classf3d_1_1window.html">Class window</a></li>
<li class="toctree-l2"><a class="reference internal" href="typedef_types_8h_1a62f3e15e4e18455b52854622b27c02ed.html">Typedef f3d::angle_deg_t</a></li>
</ul>
</li>
</ul>

    </div>
</nav></div>
    </div>
  
  
  <div class="sidebar-primary-items__end sidebar-primary__section">
  </div>
  
  <div id="rtd-footer-container"></div>


      </div>
      
      <main id="main-content" class="bd-main">
        
        

<div class="sbt-scroll-pixel-helper"></div>

          <div class="bd-content">
            <div class="bd-article-container">
              
              <div class="bd-header-article">
<div class="header-article-items header-article__inner">
  
    <div class="header-article-items__start">
      
        <div class="header-article-item"><label class="sidebar-toggle primary-toggle btn btn-sm" for="__primary" title="Toggle primary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
  <span class="fa-solid fa-bars"></span>
</label></div>
      
    </div>
  
  
    <div class="header-article-items__end">
      
        <div class="header-article-item">

<div class="article-header-buttons">





<div class="dropdown dropdown-download-buttons">
  <button class="btn dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-label="Download this page">
    <i class="fas fa-download"></i>
  </button>
  <ul class="dropdown-menu">
      
      
      
      <li><a href="../_sources/api/classf3d_1_1engine.rst" target="_blank"
   class="btn btn-sm btn-download-source-button dropdown-item"
   title="Download source file"
   data-bs-placement="left" data-bs-toggle="tooltip"
>
  

<span class="btn__icon-container">
  <i class="fas fa-file"></i>
  </span>
<span class="btn__text-container">.rst</span>
</a>
</li>
      
      
      
      
      <li>
<button onclick="window.print()"
  class="btn btn-sm btn-download-pdf-button dropdown-item"
  title="Print to PDF"
  data-bs-placement="left" data-bs-toggle="tooltip"
>
  

<span class="btn__icon-container">
  <i class="fas fa-file-pdf"></i>
  </span>
<span class="btn__text-container">.pdf</span>
</button>
</li>
      
  </ul>
</div>




<button onclick="toggleFullScreen()"
  class="btn btn-sm btn-fullscreen-button"
  title="Fullscreen mode"
  data-bs-placement="bottom" data-bs-toggle="tooltip"
>
  

<span class="btn__icon-container">
  <i class="fas fa-expand"></i>
  </span>

</button>


<script>
document.write(`
  <button class="theme-switch-button btn btn-sm btn-outline-primary navbar-btn rounded-circle" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
    <span class="theme-switch" data-mode="light"><i class="fa-solid fa-sun"></i></span>
    <span class="theme-switch" data-mode="dark"><i class="fa-solid fa-moon"></i></span>
    <span class="theme-switch" data-mode="auto"><i class="fa-solid fa-circle-half-stroke"></i></span>
  </button>
`);
</script>

<script>
document.write(`
  <button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
    <i class="fa-solid fa-magnifying-glass"></i>
  </button>
`);
</script>
<label class="sidebar-toggle secondary-toggle btn btn-sm" for="__secondary"title="Toggle secondary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
    <span class="fa-solid fa-list"></span>
</label>
</div></div>
      
    </div>
  
</div>
</div>
              
              

<div id="jb-print-docs-body" class="onlyprint">
    <h1>Class engine</h1>
    <!-- Table of contents -->
    <div id="print-main-content">
        <div id="jb-print-toc">
            
            <div>
                <h2> Contents </h2>
            </div>
            <nav aria-label="Page">
                <ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#nested-relationships">Nested Relationships</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#nested-types">Nested Types</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#class-documentation">Class Documentation</a></li>
</ul>
            </nav>
        </div>
    </div>
</div>

              
                
<div id="searchbox"></div>
                <article class="bd-article" role="main">
                  
  <section id="class-engine">
<span id="exhale-class-classf3d-1-1engine"></span><h1>Class engine<a class="headerlink" href="#class-engine" title="Permalink to this heading">#</a></h1>
<ul class="simple">
<li><p>Defined in <a class="reference internal" href="file_public_engine.h.html#file-public-engine-h"><span class="std std-ref">File engine.h</span></a></p></li>
</ul>
<section id="nested-relationships">
<h2>Nested Relationships<a class="headerlink" href="#nested-relationships" title="Permalink to this heading">#</a></h2>
<section id="nested-types">
<h3>Nested Types<a class="headerlink" href="#nested-types" title="Permalink to this heading">#</a></h3>
<ul class="simple">
<li><p><a class="reference internal" href="structf3d_1_1engine_1_1cache__exception.html#exhale-struct-structf3d-1-1engine-1-1cache-exception"><span class="std std-ref">Struct engine::cache_exception</span></a></p></li>
<li><p><a class="reference internal" href="structf3d_1_1engine_1_1libInformation.html#exhale-struct-structf3d-1-1engine-1-1libinformation"><span class="std std-ref">Struct engine::libInformation</span></a></p></li>
<li><p><a class="reference internal" href="structf3d_1_1engine_1_1no__interactor__exception.html#exhale-struct-structf3d-1-1engine-1-1no-interactor-exception"><span class="std std-ref">Struct engine::no_interactor_exception</span></a></p></li>
<li><p><a class="reference internal" href="structf3d_1_1engine_1_1no__window__exception.html#exhale-struct-structf3d-1-1engine-1-1no-window-exception"><span class="std std-ref">Struct engine::no_window_exception</span></a></p></li>
<li><p><a class="reference internal" href="structf3d_1_1engine_1_1plugin__exception.html#exhale-struct-structf3d-1-1engine-1-1plugin-exception"><span class="std std-ref">Struct engine::plugin_exception</span></a></p></li>
<li><p><a class="reference internal" href="structf3d_1_1engine_1_1readerInformation.html#exhale-struct-structf3d-1-1engine-1-1readerinformation"><span class="std std-ref">Struct engine::readerInformation</span></a></p></li>
</ul>
</section>
</section>
<section id="class-documentation">
<h2>Class Documentation<a class="headerlink" href="#class-documentation" title="Permalink to this heading">#</a></h2>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engineE">
<span id="_CPPv3N3f3d6engineE"></span><span id="_CPPv2N3f3d6engineE"></span><span id="f3d::engine"></span><span class="target" id="classf3d_1_1engine"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">engine</span></span></span><a class="headerlink" href="#_CPPv4N3f3d6engineE" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Class used to create instance of other classes. </p>
<p>The main class of the libf3d to create all other instances. Configured on creation using an enum, then all objects can be accessed through their getter.</p>
<p>Example usage for adding some files in the scene</p>
<div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="n">f3d</span><span class="o">::</span><span class="n">engine</span><span class="w"> </span><span class="n">eng</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">f3d</span><span class="o">::</span><span class="n">engine</span><span class="o">::</span><span class="n">create</span><span class="p">();</span>
<span class="n">f3d</span><span class="o">::</span><span class="n">scene</span><span class="o">&amp;</span><span class="w"> </span><span class="n">sce</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">eng</span><span class="p">.</span><span class="n">getscene</span><span class="p">();</span>
<span class="n">sce</span><span class="p">.</span><span class="n">add</span><span class="p">({</span><span class="s">&quot;path/to/file&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;path/to/another/file&quot;</span><span class="p">});</span>
<span class="n">f3d</span><span class="o">::</span><span class="n">interactor</span><span class="o">&amp;</span><span class="w"> </span><span class="n">inter</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">eng</span><span class="p">.</span><span class="n">getInteractor</span><span class="p">();</span>
<span class="n">inter</span><span class="p">.</span><span class="n">start</span><span class="p">();</span>
</pre></div>
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engineD0Ev">
<span id="_CPPv3N3f3d6engineD0Ev"></span><span id="_CPPv2N3f3d6engineD0Ev"></span><span id="f3d::engine::~engine"></span><span class="target" id="classf3d_1_1engine_1a42c3dd21a33f10e849c804d91af3ca37"></span><span class="sig-name descname"><span class="n"><span class="pre">~engine</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3f3d6engineD0Ev" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Engine destructor, delete all object instances as well. </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine6engineERK6engine">
<span id="_CPPv3N3f3d6engine6engineERK6engine"></span><span id="_CPPv2N3f3d6engine6engineERK6engine"></span><span id="f3d::engine::engine__engineCR"></span><span class="target" id="classf3d_1_1engine_1a091ec0742f81eb1931aa008b6d2eb857"></span><span class="sig-name descname"><span class="n"><span class="pre">engine</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N3f3d6engine6engineERK6engine" title="f3d::engine::engine"><span class="n"><span class="pre">engine</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">other</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="k"><span class="pre">delete</span></span><a class="headerlink" href="#_CPPv4N3f3d6engine6engineERK6engine" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Engine copy is not possible but move is allowed. </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine6engineERR6engine">
<span id="_CPPv3N3f3d6engine6engineERR6engine"></span><span id="_CPPv2N3f3d6engine6engineERR6engine"></span><span id="f3d::engine::engine__engineRR"></span><span class="target" id="classf3d_1_1engine_1a763538a512e6405aa5d05de6eef8e43e"></span><span class="sig-name descname"><span class="n"><span class="pre">engine</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4N3f3d6engine6engineERR6engine" title="f3d::engine::engine"><span class="n"><span class="pre">engine</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">other</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">noexcept</span></span><a class="headerlink" href="#_CPPv4N3f3d6engine6engineERR6engine" title="Permalink to this definition">#</a><br /></dt>
<dd></dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engineaSERK6engine">
<span id="_CPPv3N3f3d6engineaSERK6engine"></span><span id="_CPPv2N3f3d6engineaSERK6engine"></span><span id="f3d::engine::assign-operator__engineCR"></span><span class="target" id="classf3d_1_1engine_1a8fdfc778ecef67c98405ee398536f35a"></span><a class="reference internal" href="#_CPPv4N3f3d6engineE" title="f3d::engine"><span class="n"><span class="pre">engine</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="sig-name descname"><span class="k"><span class="pre">operator</span></span><span class="o"><span class="pre">=</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N3f3d6engineE" title="f3d::engine"><span class="n"><span class="pre">engine</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">other</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="k"><span class="pre">delete</span></span><a class="headerlink" href="#_CPPv4N3f3d6engineaSERK6engine" title="Permalink to this definition">#</a><br /></dt>
<dd></dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engineaSERR6engine">
<span id="_CPPv3N3f3d6engineaSERR6engine"></span><span id="_CPPv2N3f3d6engineaSERR6engine"></span><span id="f3d::engine::assign-operator__engineRR"></span><span class="target" id="classf3d_1_1engine_1a827f4de2a88678301ca79466f36e2f10"></span><a class="reference internal" href="#_CPPv4N3f3d6engineE" title="f3d::engine"><span class="n"><span class="pre">engine</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="sig-name descname"><span class="k"><span class="pre">operator</span></span><span class="o"><span class="pre">=</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4N3f3d6engineE" title="f3d::engine"><span class="n"><span class="pre">engine</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">other</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">noexcept</span></span><a class="headerlink" href="#_CPPv4N3f3d6engineaSERR6engine" title="Permalink to this definition">#</a><br /></dt>
<dd></dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine12setCachePathERKNSt10filesystem4pathE">
<span id="_CPPv3N3f3d6engine12setCachePathERKNSt10filesystem4pathE"></span><span id="_CPPv2N3f3d6engine12setCachePathERKNSt10filesystem4pathE"></span><span id="f3d::engine::setCachePath__std::filesystem::pathCR"></span><span class="target" id="classf3d_1_1engine_1aee160eb103da192e292f3e088a741005"></span><a class="reference internal" href="#_CPPv4N3f3d6engineE" title="f3d::engine"><span class="n"><span class="pre">engine</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="sig-name descname"><span class="n"><span class="pre">setCachePath</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">filesystem</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">path</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">cachePath</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3f3d6engine12setCachePathERKNSt10filesystem4pathE" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Set the cache path. The provided path is used as is. Currently, it’s only used to store HDRI baked textures. By default, the cache path is:<ul class="simple">
<li><p>Windows: LOCALAPPDATA%\f3d</p></li>
<li><p>Linux: ~/.cache/f3d</p></li>
<li><p>macOS: ~/Library/Caches/f3d Throw a <a class="reference internal" href="structf3d_1_1engine_1_1cache__exception.html#structf3d_1_1engine_1_1cache__exception"><span class="std std-ref">cache_exception</span></a> if the provided cachePath cannot be used. </p></li>
</ul>
</p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine10setOptionsERK7options">
<span id="_CPPv3N3f3d6engine10setOptionsERK7options"></span><span id="_CPPv2N3f3d6engine10setOptionsERK7options"></span><span id="f3d::engine::setOptions__optionsCR"></span><span class="target" id="classf3d_1_1engine_1a4613240a2cc5c27c0fa5f4c3107d20d7"></span><a class="reference internal" href="#_CPPv4N3f3d6engineE" title="f3d::engine"><span class="n"><span class="pre">engine</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="sig-name descname"><span class="n"><span class="pre">setOptions</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">options</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">opt</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3f3d6engine10setOptionsERK7options" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Engine provide a default options that you can use using <a class="reference internal" href="#classf3d_1_1engine_1a82afa7d56eed653f1d378489fc4a91b9"><span class="std std-ref">engine::getOptions()</span></a>. But you can use this setter to use other options directly. It will copy options into engine. </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine10setOptionsERR7options">
<span id="_CPPv3N3f3d6engine10setOptionsERR7options"></span><span id="_CPPv2N3f3d6engine10setOptionsERR7options"></span><span id="f3d::engine::setOptions__optionsRR"></span><span class="target" id="classf3d_1_1engine_1a8b69f5895974c8139dbdb47446d5b2ea"></span><a class="reference internal" href="#_CPPv4N3f3d6engineE" title="f3d::engine"><span class="n"><span class="pre">engine</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="sig-name descname"><span class="n"><span class="pre">setOptions</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">options</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">opt</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3f3d6engine10setOptionsERR7options" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Engine provide a default options that you can use using <a class="reference internal" href="#classf3d_1_1engine_1a82afa7d56eed653f1d378489fc4a91b9"><span class="std std-ref">engine::getOptions()</span></a>. But you can use this setter to use other options directly. It will move options into engine. </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine10getOptionsEv">
<span id="_CPPv3N3f3d6engine10getOptionsEv"></span><span id="_CPPv2N3f3d6engine10getOptionsEv"></span><span id="f3d::engine::getOptions"></span><span class="target" id="classf3d_1_1engine_1a82afa7d56eed653f1d378489fc4a91b9"></span><span class="n"><span class="pre">options</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="sig-name descname"><span class="n"><span class="pre">getOptions</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3f3d6engine10getOptionsEv" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Get the default options provided by the engine. </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine9getWindowEv">
<span id="_CPPv3N3f3d6engine9getWindowEv"></span><span id="_CPPv2N3f3d6engine9getWindowEv"></span><span id="f3d::engine::getWindow"></span><span class="target" id="classf3d_1_1engine_1a2821be632c112a33ac0f45bbbe4e4ba6"></span><a class="reference internal" href="classf3d_1_1window.html#_CPPv4N3f3d6windowE" title="f3d::window"><span class="n"><span class="pre">window</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="sig-name descname"><span class="n"><span class="pre">getWindow</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3f3d6engine9getWindowEv" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Get the window provided by the engine, if any. If not, will throw a <a class="reference internal" href="structf3d_1_1engine_1_1no__window__exception.html#structf3d_1_1engine_1_1no__window__exception"><span class="std std-ref">engine::no_window_exception</span></a>. </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine8getSceneEv">
<span id="_CPPv3N3f3d6engine8getSceneEv"></span><span id="_CPPv2N3f3d6engine8getSceneEv"></span><span id="f3d::engine::getScene"></span><span class="target" id="classf3d_1_1engine_1aa2ade054b183cefb18d8e395af49ea91"></span><a class="reference internal" href="classf3d_1_1scene.html#_CPPv4N3f3d5sceneE" title="f3d::scene"><span class="n"><span class="pre">scene</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="sig-name descname"><span class="n"><span class="pre">getScene</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3f3d6engine8getSceneEv" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Get the loaded provided by the engine. </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine13getInteractorEv">
<span id="_CPPv3N3f3d6engine13getInteractorEv"></span><span id="_CPPv2N3f3d6engine13getInteractorEv"></span><span id="f3d::engine::getInteractor"></span><span class="target" id="classf3d_1_1engine_1aa4c34af23d40b4faab24d317468ec934"></span><a class="reference internal" href="classf3d_1_1interactor.html#_CPPv4N3f3d10interactorE" title="f3d::interactor"><span class="n"><span class="pre">interactor</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="sig-name descname"><span class="n"><span class="pre">getInteractor</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3f3d6engine13getInteractorEv" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Get the interactor provided by the engine, if any. If not, will throw a <a class="reference internal" href="structf3d_1_1engine_1_1no__interactor__exception.html#structf3d_1_1engine_1_1no__interactor__exception"><span class="std std-ref">engine::no_interactor_exception</span></a>. </p>
</dd></dl>

</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-functions">Public Static Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine6createEb">
<span id="_CPPv3N3f3d6engine6createEb"></span><span id="_CPPv2N3f3d6engine6createEb"></span><span id="f3d::engine::create__b"></span><span class="target" id="classf3d_1_1engine_1a8dc98863d9785dee5c90725248c46b8a"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N3f3d6engineE" title="f3d::engine"><span class="n"><span class="pre">engine</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">create</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">offscreen</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="k"><span class="pre">false</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3f3d6engine6createEb" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Create an engine with an automatic window. Optionally, the window can be hidden by setting offscreen to true. For VTK &lt; 9.3, the window type will depend on the VTK build options For VTK &gt;= 9.4: Linux: Try GLX, then EGL, then OSMesa Windows: Try Win32, then EGL, then OSMesa macOS: Always use Cocoa Throws a <a class="reference internal" href="structf3d_1_1context_1_1loading__exception.html#structf3d_1_1context_1_1loading__exception"><span class="std std-ref">context::loading_exception</span></a> if a needed graphic library cannot be loaded Throws a <a class="reference internal" href="structf3d_1_1context_1_1symbol__exception.html#structf3d_1_1context_1_1symbol__exception"><span class="std std-ref">context::symbol_exception</span></a> if a needed symbol cannot be found in graphic library Throws a <a class="reference internal" href="structf3d_1_1engine_1_1no__window__exception.html#structf3d_1_1engine_1_1no__window__exception"><span class="std std-ref">engine::no_window_exception</span></a> if the window cannot be created for another reason Throws a <a class="reference internal" href="structf3d_1_1engine_1_1cache__exception.html#structf3d_1_1engine_1_1cache__exception"><span class="std std-ref">engine::cache_exception</span></a> if the default cache directory cannot be used </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine10createNoneEv">
<span id="_CPPv3N3f3d6engine10createNoneEv"></span><span id="_CPPv2N3f3d6engine10createNoneEv"></span><span id="f3d::engine::createNone"></span><span class="target" id="classf3d_1_1engine_1a6c74166d9132a8e0e30e7bd8c4a3ce0f"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N3f3d6engineE" title="f3d::engine"><span class="n"><span class="pre">engine</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">createNone</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3f3d6engine10createNoneEv" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Create an engine with no window. Throws a <a class="reference internal" href="structf3d_1_1engine_1_1no__window__exception.html#structf3d_1_1engine_1_1no__window__exception"><span class="std std-ref">engine::no_window_exception</span></a> if the window cannot be created for another reason Throws a <a class="reference internal" href="structf3d_1_1engine_1_1cache__exception.html#structf3d_1_1engine_1_1cache__exception"><span class="std std-ref">engine::cache_exception</span></a> if the default cache directory cannot be used </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine9createGLXEb">
<span id="_CPPv3N3f3d6engine9createGLXEb"></span><span id="_CPPv2N3f3d6engine9createGLXEb"></span><span id="f3d::engine::createGLX__b"></span><span class="target" id="classf3d_1_1engine_1a0cf626f2585af37614b088c5c78a2a1a"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N3f3d6engineE" title="f3d::engine"><span class="n"><span class="pre">engine</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">createGLX</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">offscreen</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="k"><span class="pre">false</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3f3d6engine9createGLXEb" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Create an engine with a GLX window. Works on Linux only. VTK &gt;= 9.4 required. Optionally, the window can be hidden by setting offscreen to true. Throws a <a class="reference internal" href="structf3d_1_1context_1_1loading__exception.html#structf3d_1_1context_1_1loading__exception"><span class="std std-ref">context::loading_exception</span></a> if a needed graphic library cannot be loaded Throws a <a class="reference internal" href="structf3d_1_1context_1_1symbol__exception.html#structf3d_1_1context_1_1symbol__exception"><span class="std std-ref">context::symbol_exception</span></a> if a needed symbol cannot be found in graphic library Throws a <a class="reference internal" href="structf3d_1_1engine_1_1no__window__exception.html#structf3d_1_1engine_1_1no__window__exception"><span class="std std-ref">engine::no_window_exception</span></a> if the window cannot be created for another reason Throws a <a class="reference internal" href="structf3d_1_1engine_1_1cache__exception.html#structf3d_1_1engine_1_1cache__exception"><span class="std std-ref">engine::cache_exception</span></a> if the default cache directory cannot be used </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine9createWGLEb">
<span id="_CPPv3N3f3d6engine9createWGLEb"></span><span id="_CPPv2N3f3d6engine9createWGLEb"></span><span id="f3d::engine::createWGL__b"></span><span class="target" id="classf3d_1_1engine_1aad8377f8ceef620a494c3d1ccb86ef4a"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N3f3d6engineE" title="f3d::engine"><span class="n"><span class="pre">engine</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">createWGL</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">offscreen</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="k"><span class="pre">false</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3f3d6engine9createWGLEb" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Create an engine with a WGL window. Works on Windows only. VTK &gt;= 9.4 required. Optionally, the window can be hidden by setting offscreen to true. Throws a <a class="reference internal" href="structf3d_1_1context_1_1loading__exception.html#structf3d_1_1context_1_1loading__exception"><span class="std std-ref">context::loading_exception</span></a> if a needed graphic library cannot be loaded Throws a <a class="reference internal" href="structf3d_1_1context_1_1symbol__exception.html#structf3d_1_1context_1_1symbol__exception"><span class="std std-ref">context::symbol_exception</span></a> if a needed symbol cannot be found in graphic library Throws a <a class="reference internal" href="structf3d_1_1engine_1_1no__window__exception.html#structf3d_1_1engine_1_1no__window__exception"><span class="std std-ref">engine::no_window_exception</span></a> if the window cannot be created for another reason Throws a <a class="reference internal" href="structf3d_1_1engine_1_1cache__exception.html#structf3d_1_1engine_1_1cache__exception"><span class="std std-ref">engine::cache_exception</span></a> if the default cache directory cannot be used </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine9createEGLEv">
<span id="_CPPv3N3f3d6engine9createEGLEv"></span><span id="_CPPv2N3f3d6engine9createEGLEv"></span><span id="f3d::engine::createEGL"></span><span class="target" id="classf3d_1_1engine_1af2ad280d2be4c58a8f30eec351cd3bf4"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N3f3d6engineE" title="f3d::engine"><span class="n"><span class="pre">engine</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">createEGL</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3f3d6engine9createEGLEv" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Create an engine with an offscreen EGL window. VTK &gt;= 9.4 required. If several GPU are available, the environment variable <code class="docutils literal notranslate"><span class="pre">VTK_DEFAULT_EGL_DEVICE_INDEX</span></code> allows its selection. Throws a <a class="reference internal" href="structf3d_1_1context_1_1loading__exception.html#structf3d_1_1context_1_1loading__exception"><span class="std std-ref">context::loading_exception</span></a> if a needed graphic library cannot be loaded Throws a <a class="reference internal" href="structf3d_1_1context_1_1symbol__exception.html#structf3d_1_1context_1_1symbol__exception"><span class="std std-ref">context::symbol_exception</span></a> if a needed symbol cannot be found in graphic library Throws a <a class="reference internal" href="structf3d_1_1engine_1_1no__window__exception.html#structf3d_1_1engine_1_1no__window__exception"><span class="std std-ref">engine::no_window_exception</span></a> if the window cannot be created for another reason Throws a <a class="reference internal" href="structf3d_1_1engine_1_1cache__exception.html#structf3d_1_1engine_1_1cache__exception"><span class="std std-ref">engine::cache_exception</span></a> if the default cache directory cannot be used </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine12createOSMesaEv">
<span id="_CPPv3N3f3d6engine12createOSMesaEv"></span><span id="_CPPv2N3f3d6engine12createOSMesaEv"></span><span id="f3d::engine::createOSMesa"></span><span class="target" id="classf3d_1_1engine_1a1ea3b63b10d5f826528545a562297cd1"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N3f3d6engineE" title="f3d::engine"><span class="n"><span class="pre">engine</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">createOSMesa</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3f3d6engine12createOSMesaEv" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Create an engine with an offscreen OSMesa window. VTK &gt;= 9.4 required. Throws a <a class="reference internal" href="structf3d_1_1context_1_1loading__exception.html#structf3d_1_1context_1_1loading__exception"><span class="std std-ref">context::loading_exception</span></a> if a needed graphic library cannot be loaded Throws a <a class="reference internal" href="structf3d_1_1context_1_1symbol__exception.html#structf3d_1_1context_1_1symbol__exception"><span class="std std-ref">context::symbol_exception</span></a> if a needed symbol cannot be found in graphic library Throws a <a class="reference internal" href="structf3d_1_1engine_1_1no__window__exception.html#structf3d_1_1engine_1_1no__window__exception"><span class="std std-ref">engine::no_window_exception</span></a> if the window cannot be created for another reason Throws a <a class="reference internal" href="structf3d_1_1engine_1_1cache__exception.html#structf3d_1_1engine_1_1cache__exception"><span class="std std-ref">engine::cache_exception</span></a> if the default cache directory cannot be used </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine14createExternalERKN7context8functionE">
<span id="_CPPv3N3f3d6engine14createExternalERKN7context8functionE"></span><span id="_CPPv2N3f3d6engine14createExternalERKN7context8functionE"></span><span id="f3d::engine::createExternal__context::functionCR"></span><span class="target" id="classf3d_1_1engine_1ad34defb23976727cdb2ae884e119e533"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N3f3d6engineE" title="f3d::engine"><span class="n"><span class="pre">engine</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">createExternal</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="classf3d_1_1context.html#_CPPv4N3f3d7contextE" title="f3d::context"><span class="n"><span class="pre">context</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="classf3d_1_1context.html#_CPPv4N3f3d7context8functionE" title="f3d::context::function"><span class="n"><span class="pre">function</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">getProcAddress</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3f3d6engine14createExternalERKN7context8functionE" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Create an engine with an external window. A context to retrieve OpenGL symbols is required. The context can be nullptr for an external Cocoa window. Here’s an example if a GLFW window is used: <div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="n">f3d</span><span class="o">::</span><span class="n">engine</span><span class="w"> </span><span class="n">eng</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">f3d</span><span class="o">::</span><span class="n">engine</span><span class="o">::</span><span class="n">createExternal</span><span class="p">(</span><span class="n">glfwGetProcAddress</span><span class="p">);</span>
</pre></div>
</div>
 Throws a <a class="reference internal" href="structf3d_1_1engine_1_1no__window__exception.html#structf3d_1_1engine_1_1no__window__exception"><span class="std std-ref">engine::no_window_exception</span></a> if the window cannot be created for another reason Throws a <a class="reference internal" href="structf3d_1_1engine_1_1cache__exception.html#structf3d_1_1engine_1_1cache__exception"><span class="std std-ref">engine::cache_exception</span></a> if the default cache directory cannot be used </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine17createExternalGLXEv">
<span id="_CPPv3N3f3d6engine17createExternalGLXEv"></span><span id="_CPPv2N3f3d6engine17createExternalGLXEv"></span><span id="f3d::engine::createExternalGLX"></span><span class="target" id="classf3d_1_1engine_1a4fc077683aa9807ce52d3c0b45494250"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N3f3d6engineE" title="f3d::engine"><span class="n"><span class="pre">engine</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">createExternalGLX</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3f3d6engine17createExternalGLXEv" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Create an engine with an external GLX context. Equivalent to createExternal(f3d::context::glx()); VTK &gt;= 9.4 required. Throws a <a class="reference internal" href="structf3d_1_1context_1_1loading__exception.html#structf3d_1_1context_1_1loading__exception"><span class="std std-ref">context::loading_exception</span></a> if a needed graphic library cannot be loaded Throws a <a class="reference internal" href="structf3d_1_1context_1_1symbol__exception.html#structf3d_1_1context_1_1symbol__exception"><span class="std std-ref">context::symbol_exception</span></a> if a needed symbol cannot be found in graphic library Throws a <a class="reference internal" href="structf3d_1_1engine_1_1no__window__exception.html#structf3d_1_1engine_1_1no__window__exception"><span class="std std-ref">engine::no_window_exception</span></a> if the window cannot be created for another reason Throws a <a class="reference internal" href="structf3d_1_1engine_1_1cache__exception.html#structf3d_1_1engine_1_1cache__exception"><span class="std std-ref">engine::cache_exception</span></a> if the default cache directory cannot be used </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine17createExternalWGLEv">
<span id="_CPPv3N3f3d6engine17createExternalWGLEv"></span><span id="_CPPv2N3f3d6engine17createExternalWGLEv"></span><span id="f3d::engine::createExternalWGL"></span><span class="target" id="classf3d_1_1engine_1aa5ae12e2c05726524b94df82f63e1cc3"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N3f3d6engineE" title="f3d::engine"><span class="n"><span class="pre">engine</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">createExternalWGL</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3f3d6engine17createExternalWGLEv" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Create an engine with an external WGL context. Equivalent to createExternal(f3d::context::wgl()); VTK &gt;= 9.4 required. Throws a <a class="reference internal" href="structf3d_1_1context_1_1loading__exception.html#structf3d_1_1context_1_1loading__exception"><span class="std std-ref">context::loading_exception</span></a> if a needed graphic library cannot be loaded Throws a <a class="reference internal" href="structf3d_1_1context_1_1symbol__exception.html#structf3d_1_1context_1_1symbol__exception"><span class="std std-ref">context::symbol_exception</span></a> if a needed symbol cannot be found in graphic library Throws a <a class="reference internal" href="structf3d_1_1engine_1_1no__window__exception.html#structf3d_1_1engine_1_1no__window__exception"><span class="std std-ref">engine::no_window_exception</span></a> if the window cannot be created for another reason Throws a <a class="reference internal" href="structf3d_1_1engine_1_1cache__exception.html#structf3d_1_1engine_1_1cache__exception"><span class="std std-ref">engine::cache_exception</span></a> if the default cache directory cannot be used </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine19createExternalCOCOAEv">
<span id="_CPPv3N3f3d6engine19createExternalCOCOAEv"></span><span id="_CPPv2N3f3d6engine19createExternalCOCOAEv"></span><span id="f3d::engine::createExternalCOCOA"></span><span class="target" id="classf3d_1_1engine_1aa361310e43db522f80340d1b6489f614"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N3f3d6engineE" title="f3d::engine"><span class="n"><span class="pre">engine</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">createExternalCOCOA</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3f3d6engine19createExternalCOCOAEv" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Create an engine with an external COCOA context. Equivalent to createExternal(f3d::context::cocoa()); VTK &gt;= 9.4 required. Throws a <a class="reference internal" href="structf3d_1_1context_1_1loading__exception.html#structf3d_1_1context_1_1loading__exception"><span class="std std-ref">context::loading_exception</span></a> if a needed graphic library cannot be loaded Throws a <a class="reference internal" href="structf3d_1_1context_1_1symbol__exception.html#structf3d_1_1context_1_1symbol__exception"><span class="std std-ref">context::symbol_exception</span></a> if a needed symbol cannot be found in graphic library Throws a <a class="reference internal" href="structf3d_1_1engine_1_1no__window__exception.html#structf3d_1_1engine_1_1no__window__exception"><span class="std std-ref">engine::no_window_exception</span></a> if the window cannot be created for another reason Throws a <a class="reference internal" href="structf3d_1_1engine_1_1cache__exception.html#structf3d_1_1engine_1_1cache__exception"><span class="std std-ref">engine::cache_exception</span></a> if the default cache directory cannot be used </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine17createExternalEGLEv">
<span id="_CPPv3N3f3d6engine17createExternalEGLEv"></span><span id="_CPPv2N3f3d6engine17createExternalEGLEv"></span><span id="f3d::engine::createExternalEGL"></span><span class="target" id="classf3d_1_1engine_1a033427bc8d9cfc37340d566e7d901fbe"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N3f3d6engineE" title="f3d::engine"><span class="n"><span class="pre">engine</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">createExternalEGL</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3f3d6engine17createExternalEGLEv" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Create an engine with an external EGL context. Equivalent to createExternal(f3d::context::egl()); VTK &gt;= 9.4 required. Throws a <a class="reference internal" href="structf3d_1_1context_1_1loading__exception.html#structf3d_1_1context_1_1loading__exception"><span class="std std-ref">context::loading_exception</span></a> if a needed graphic library cannot be loaded Throws a <a class="reference internal" href="structf3d_1_1context_1_1symbol__exception.html#structf3d_1_1context_1_1symbol__exception"><span class="std std-ref">context::symbol_exception</span></a> if a needed symbol cannot be found in graphic library Throws a <a class="reference internal" href="structf3d_1_1engine_1_1no__window__exception.html#structf3d_1_1engine_1_1no__window__exception"><span class="std std-ref">engine::no_window_exception</span></a> if the window cannot be created for another reason Throws a <a class="reference internal" href="structf3d_1_1engine_1_1cache__exception.html#structf3d_1_1engine_1_1cache__exception"><span class="std std-ref">engine::cache_exception</span></a> if the default cache directory cannot be used </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine20createExternalOSMesaEv">
<span id="_CPPv3N3f3d6engine20createExternalOSMesaEv"></span><span id="_CPPv2N3f3d6engine20createExternalOSMesaEv"></span><span id="f3d::engine::createExternalOSMesa"></span><span class="target" id="classf3d_1_1engine_1a2228768b97a56a53ce23fb315ff368ab"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N3f3d6engineE" title="f3d::engine"><span class="n"><span class="pre">engine</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">createExternalOSMesa</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3f3d6engine20createExternalOSMesaEv" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Create an engine with an external OSMesa context. Equivalent to createExternal(f3d::context::osmesa()); VTK &gt;= 9.4 required. Throws a <a class="reference internal" href="structf3d_1_1context_1_1loading__exception.html#structf3d_1_1context_1_1loading__exception"><span class="std std-ref">context::loading_exception</span></a> if a needed graphic library cannot be loaded Throws a <a class="reference internal" href="structf3d_1_1context_1_1symbol__exception.html#structf3d_1_1context_1_1symbol__exception"><span class="std std-ref">context::symbol_exception</span></a> if a needed symbol cannot be found in graphic library Throws a <a class="reference internal" href="structf3d_1_1engine_1_1no__window__exception.html#structf3d_1_1engine_1_1no__window__exception"><span class="std std-ref">engine::no_window_exception</span></a> if the window cannot be created for another reason Throws a <a class="reference internal" href="structf3d_1_1engine_1_1cache__exception.html#structf3d_1_1engine_1_1cache__exception"><span class="std std-ref">engine::cache_exception</span></a> if the default cache directory cannot be used </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine23getRenderingBackendListEv">
<span id="_CPPv3N3f3d6engine23getRenderingBackendListEv"></span><span id="_CPPv2N3f3d6engine23getRenderingBackendListEv"></span><span id="f3d::engine::getRenderingBackendList"></span><span class="target" id="classf3d_1_1engine_1ac90219b1ae4d22207f8ccdaf7fa3f8ba"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">map</span></span><span class="p"><span class="pre">&lt;</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">getRenderingBackendList</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3f3d6engine23getRenderingBackendListEv" title="Permalink to this definition">#</a><br /></dt>
<dd><p>List rendering backends supported by libf3d. All backends have an associated boolean flag indicating if it can be used. </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine10loadPluginERKNSt6stringERKNSt6vectorINSt10filesystem4pathEEE">
<span id="_CPPv3N3f3d6engine10loadPluginERKNSt6stringERKNSt6vectorINSt10filesystem4pathEEE"></span><span id="_CPPv2N3f3d6engine10loadPluginERKNSt6stringERKNSt6vectorINSt10filesystem4pathEEE"></span><span id="f3d::engine::loadPlugin__ssCR.std::vector:std::filesystem::path:CR"></span><span class="target" id="classf3d_1_1engine_1a820b4a59f829b77f669f267cfde09186"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">loadPlugin</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">pathOrName</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre">&lt;</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">filesystem</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">pluginSearchPaths</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="p"><span class="pre">{</span></span><span class="p"><span class="pre">}</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3f3d6engine10loadPluginERKNSt6stringERKNSt6vectorINSt10filesystem4pathEEE" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Load a plugin. The provided pathOrName can be a full path, relative path, or plugin name. First try to load the plugin by name from the static plugins. Then try to load the path provided as if it is a full path to a plugin. Then try to load a plugin by its name looking into the provided plugin search paths (used as is). Then try to load a plugin by its name relying on internal system (eg: LD_LIBRARY_PATH). The plugin “native” is always available and includes native VTK readers. If built and available in your build, F3D is providing 5 additional plugins: “alembic”, “assimp”, “draco”, “exodus”, “occt”, “usd”. Custom plugins can also be available that F3D is not supporting officially. Throw a <a class="reference internal" href="structf3d_1_1engine_1_1plugin__exception.html#structf3d_1_1engine_1_1plugin__exception"><span class="std std-ref">plugin_exception</span></a> if the plugin can’t be loaded for some reason. </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine15autoloadPluginsEv">
<span id="_CPPv3N3f3d6engine15autoloadPluginsEv"></span><span id="_CPPv2N3f3d6engine15autoloadPluginsEv"></span><span id="f3d::engine::autoloadPlugins"></span><span class="target" id="classf3d_1_1engine_1ac4d909a879b94b496a3e9292162fb855"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">autoloadPlugins</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3f3d6engine15autoloadPluginsEv" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Automatically load all the static plugins. The plugin “native” is guaranteed to be static. </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine14getPluginsListERKNSt10filesystem4pathE">
<span id="_CPPv3N3f3d6engine14getPluginsListERKNSt10filesystem4pathE"></span><span id="_CPPv2N3f3d6engine14getPluginsListERKNSt10filesystem4pathE"></span><span id="f3d::engine::getPluginsList__std::filesystem::pathCR"></span><span class="target" id="classf3d_1_1engine_1adc7ed93ade646d5995c8e235d72f67d8"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre">&lt;</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">getPluginsList</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">filesystem</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">path</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">pluginPath</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3f3d6engine14getPluginsListERKNSt10filesystem4pathE" title="Permalink to this definition">#</a><br /></dt>
<dd><p>List plugins based on associated json files located in the given directory, used as is. Listed plugins can be loaded using <a class="reference internal" href="#classf3d_1_1engine_1a820b4a59f829b77f669f267cfde09186"><span class="std std-ref">engine::loadPlugin</span></a> function. Note that the listed plugins may fail to load if the library is not found or incompatible. Return available plugins if any, or an empty vector if there are none or the provided path does not exist. </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine10getLibInfoEv">
<span id="_CPPv3N3f3d6engine10getLibInfoEv"></span><span id="_CPPv2N3f3d6engine10getLibInfoEv"></span><span id="f3d::engine::getLibInfo"></span><span class="target" id="classf3d_1_1engine_1aaf3b6314d61f6b033887ed09255fe5a7"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N3f3d6engine14libInformationE" title="f3d::engine::libInformation"><span class="n"><span class="pre">libInformation</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">getLibInfo</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3f3d6engine10getLibInfoEv" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Get a struct containing info about the libf3d. </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine14getReadersInfoEv">
<span id="_CPPv3N3f3d6engine14getReadersInfoEv"></span><span id="_CPPv2N3f3d6engine14getReadersInfoEv"></span><span id="f3d::engine::getReadersInfo"></span><span class="target" id="classf3d_1_1engine_1aaf69c1661ba19ff28bb45eb3332841c3"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre">&lt;</span></span><a class="reference internal" href="#_CPPv4N3f3d6engine17readerInformationE" title="f3d::engine::readerInformation"><span class="n"><span class="pre">readerInformation</span></span></a><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">getReadersInfo</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3f3d6engine14getReadersInfoEv" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Get a vector of struct containing info about the supported readers. </p>
</dd></dl>

</div>
<dl class="cpp struct">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine15cache_exceptionE">
<span id="_CPPv3N3f3d6engine15cache_exceptionE"></span><span id="_CPPv2N3f3d6engine15cache_exceptionE"></span><span id="f3d::engine::cache_exception"></span><span class="target" id="structf3d_1_1engine_1_1cache__exception"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">cache_exception</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">f3d</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="class_structf3d_1_1exception.html#_CPPv4N3f3d9exceptionE" title="f3d::exception"><span class="n"><span class="pre">exception</span></span></a><a class="headerlink" href="#_CPPv4N3f3d6engine15cache_exceptionE" title="Permalink to this definition">#</a><br /></dt>
<dd><p>An exception that can be thrown by the engine when the cache cannot be used </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine15cache_exception15cache_exceptionERKNSt6stringE">
<span id="_CPPv3N3f3d6engine15cache_exception15cache_exceptionERKNSt6stringE"></span><span id="_CPPv2N3f3d6engine15cache_exception15cache_exceptionERKNSt6stringE"></span><span id="f3d::engine::cache_exception::cache_exception__ssCR"></span><span class="target" id="structf3d_1_1engine_1_1cache__exception_1ab75d07f81b5a88b12a4e45781aed373d"></span><span class="k"><span class="pre">explicit</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">cache_exception</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">what</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">&quot;&quot;</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3f3d6engine15cache_exception15cache_exceptionERKNSt6stringE" title="Permalink to this definition">#</a><br /></dt>
<dd></dd></dl>

</div>
</dd></dl>

<dl class="cpp struct">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine14libInformationE">
<span id="_CPPv3N3f3d6engine14libInformationE"></span><span id="_CPPv2N3f3d6engine14libInformationE"></span><span id="f3d::engine::libInformation"></span><span class="target" id="structf3d_1_1engine_1_1libInformation"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">libInformation</span></span></span><a class="headerlink" href="#_CPPv4N3f3d6engine14libInformationE" title="Permalink to this definition">#</a><br /></dt>
<dd><p>A structure providing information about the libf3d. Returned by <a class="reference internal" href="#classf3d_1_1engine_1aaf3b6314d61f6b033887ed09255fe5a7"><span class="std std-ref">getLibInfo()</span></a>. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine14libInformation7VersionE">
<span id="_CPPv3N3f3d6engine14libInformation7VersionE"></span><span id="_CPPv2N3f3d6engine14libInformation7VersionE"></span><span id="f3d::engine::libInformation::Version__ss"></span><span class="target" id="structf3d_1_1engine_1_1libInformation_1a77e76b84e18488fd4cbc69011632809c"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Version</span></span></span><a class="headerlink" href="#_CPPv4N3f3d6engine14libInformation7VersionE" title="Permalink to this definition">#</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine14libInformation11VersionFullE">
<span id="_CPPv3N3f3d6engine14libInformation11VersionFullE"></span><span id="_CPPv2N3f3d6engine14libInformation11VersionFullE"></span><span id="f3d::engine::libInformation::VersionFull__ss"></span><span class="target" id="structf3d_1_1engine_1_1libInformation_1a22ab02e3f1d8e92fbd4e391bdbab16ee"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">VersionFull</span></span></span><a class="headerlink" href="#_CPPv4N3f3d6engine14libInformation11VersionFullE" title="Permalink to this definition">#</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine14libInformation9BuildDateE">
<span id="_CPPv3N3f3d6engine14libInformation9BuildDateE"></span><span id="_CPPv2N3f3d6engine14libInformation9BuildDateE"></span><span id="f3d::engine::libInformation::BuildDate__ss"></span><span class="target" id="structf3d_1_1engine_1_1libInformation_1a96f5421664b16f4911a2a244a5b17130"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">BuildDate</span></span></span><a class="headerlink" href="#_CPPv4N3f3d6engine14libInformation9BuildDateE" title="Permalink to this definition">#</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine14libInformation11BuildSystemE">
<span id="_CPPv3N3f3d6engine14libInformation11BuildSystemE"></span><span id="_CPPv2N3f3d6engine14libInformation11BuildSystemE"></span><span id="f3d::engine::libInformation::BuildSystem__ss"></span><span class="target" id="structf3d_1_1engine_1_1libInformation_1a9bc8f08c8a6a54d8c398db63a100f103"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">BuildSystem</span></span></span><a class="headerlink" href="#_CPPv4N3f3d6engine14libInformation11BuildSystemE" title="Permalink to this definition">#</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine14libInformation8CompilerE">
<span id="_CPPv3N3f3d6engine14libInformation8CompilerE"></span><span id="_CPPv2N3f3d6engine14libInformation8CompilerE"></span><span id="f3d::engine::libInformation::Compiler__ss"></span><span class="target" id="structf3d_1_1engine_1_1libInformation_1a89403217bdae41dc3cb2af5a46123fc2"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Compiler</span></span></span><a class="headerlink" href="#_CPPv4N3f3d6engine14libInformation8CompilerE" title="Permalink to this definition">#</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine14libInformation7ModulesE">
<span id="_CPPv3N3f3d6engine14libInformation7ModulesE"></span><span id="_CPPv2N3f3d6engine14libInformation7ModulesE"></span><span id="f3d::engine::libInformation::Modules__std::map:ss.b:"></span><span class="target" id="structf3d_1_1engine_1_1libInformation_1ae91661d2e5ec8af1db9b73ac3a38fe45"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">map</span></span><span class="p"><span class="pre">&lt;</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Modules</span></span></span><a class="headerlink" href="#_CPPv4N3f3d6engine14libInformation7ModulesE" title="Permalink to this definition">#</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine14libInformation10VTKVersionE">
<span id="_CPPv3N3f3d6engine14libInformation10VTKVersionE"></span><span id="_CPPv2N3f3d6engine14libInformation10VTKVersionE"></span><span id="f3d::engine::libInformation::VTKVersion__ss"></span><span class="target" id="structf3d_1_1engine_1_1libInformation_1ae18443c52968409bbba45aa86ecbe116"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">VTKVersion</span></span></span><a class="headerlink" href="#_CPPv4N3f3d6engine14libInformation10VTKVersionE" title="Permalink to this definition">#</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine14libInformation10CopyrightsE">
<span id="_CPPv3N3f3d6engine14libInformation10CopyrightsE"></span><span id="_CPPv2N3f3d6engine14libInformation10CopyrightsE"></span><span id="f3d::engine::libInformation::Copyrights__std::vector:ss:"></span><span class="target" id="structf3d_1_1engine_1_1libInformation_1aa5fcaf4da0e499f963511197bafcaa68"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre">&lt;</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Copyrights</span></span></span><a class="headerlink" href="#_CPPv4N3f3d6engine14libInformation10CopyrightsE" title="Permalink to this definition">#</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine14libInformation7LicenseE">
<span id="_CPPv3N3f3d6engine14libInformation7LicenseE"></span><span id="_CPPv2N3f3d6engine14libInformation7LicenseE"></span><span id="f3d::engine::libInformation::License__ss"></span><span class="target" id="structf3d_1_1engine_1_1libInformation_1aa1fc55f2019aefc29181dc1220d29093"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">License</span></span></span><a class="headerlink" href="#_CPPv4N3f3d6engine14libInformation7LicenseE" title="Permalink to this definition">#</a><br /></dt>
<dd></dd></dl>

</div>
</dd></dl>

<dl class="cpp struct">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine23no_interactor_exceptionE">
<span id="_CPPv3N3f3d6engine23no_interactor_exceptionE"></span><span id="_CPPv2N3f3d6engine23no_interactor_exceptionE"></span><span id="f3d::engine::no_interactor_exception"></span><span class="target" id="structf3d_1_1engine_1_1no__interactor__exception"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">no_interactor_exception</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">f3d</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="class_structf3d_1_1exception.html#_CPPv4N3f3d9exceptionE" title="f3d::exception"><span class="n"><span class="pre">exception</span></span></a><a class="headerlink" href="#_CPPv4N3f3d6engine23no_interactor_exceptionE" title="Permalink to this definition">#</a><br /></dt>
<dd><p>An exception that can be thrown by the engine when no interactor is available . </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine23no_interactor_exception23no_interactor_exceptionERKNSt6stringE">
<span id="_CPPv3N3f3d6engine23no_interactor_exception23no_interactor_exceptionERKNSt6stringE"></span><span id="_CPPv2N3f3d6engine23no_interactor_exception23no_interactor_exceptionERKNSt6stringE"></span><span id="f3d::engine::no_interactor_exception::no_interactor_exception__ssCR"></span><span class="target" id="structf3d_1_1engine_1_1no__interactor__exception_1ab6af47fb76e7a030e2cd4353387277e3"></span><span class="k"><span class="pre">explicit</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">no_interactor_exception</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">what</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">&quot;&quot;</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3f3d6engine23no_interactor_exception23no_interactor_exceptionERKNSt6stringE" title="Permalink to this definition">#</a><br /></dt>
<dd></dd></dl>

</div>
</dd></dl>

<dl class="cpp struct">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine19no_window_exceptionE">
<span id="_CPPv3N3f3d6engine19no_window_exceptionE"></span><span id="_CPPv2N3f3d6engine19no_window_exceptionE"></span><span id="f3d::engine::no_window_exception"></span><span class="target" id="structf3d_1_1engine_1_1no__window__exception"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">no_window_exception</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">f3d</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="class_structf3d_1_1exception.html#_CPPv4N3f3d9exceptionE" title="f3d::exception"><span class="n"><span class="pre">exception</span></span></a><a class="headerlink" href="#_CPPv4N3f3d6engine19no_window_exceptionE" title="Permalink to this definition">#</a><br /></dt>
<dd><p>An exception that can be thrown by the engine when no window is available. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine19no_window_exception19no_window_exceptionERKNSt6stringE">
<span id="_CPPv3N3f3d6engine19no_window_exception19no_window_exceptionERKNSt6stringE"></span><span id="_CPPv2N3f3d6engine19no_window_exception19no_window_exceptionERKNSt6stringE"></span><span id="f3d::engine::no_window_exception::no_window_exception__ssCR"></span><span class="target" id="structf3d_1_1engine_1_1no__window__exception_1a696bd4e971733f40df2d91c2a8ff0f64"></span><span class="k"><span class="pre">explicit</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">no_window_exception</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">what</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">&quot;&quot;</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3f3d6engine19no_window_exception19no_window_exceptionERKNSt6stringE" title="Permalink to this definition">#</a><br /></dt>
<dd></dd></dl>

</div>
</dd></dl>

<dl class="cpp struct">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine16plugin_exceptionE">
<span id="_CPPv3N3f3d6engine16plugin_exceptionE"></span><span id="_CPPv2N3f3d6engine16plugin_exceptionE"></span><span id="f3d::engine::plugin_exception"></span><span class="target" id="structf3d_1_1engine_1_1plugin__exception"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">plugin_exception</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">f3d</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="class_structf3d_1_1exception.html#_CPPv4N3f3d9exceptionE" title="f3d::exception"><span class="n"><span class="pre">exception</span></span></a><a class="headerlink" href="#_CPPv4N3f3d6engine16plugin_exceptionE" title="Permalink to this definition">#</a><br /></dt>
<dd><p>An exception that can be thrown by the engine when a plugin cannot be loaded. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine16plugin_exception16plugin_exceptionERKNSt6stringE">
<span id="_CPPv3N3f3d6engine16plugin_exception16plugin_exceptionERKNSt6stringE"></span><span id="_CPPv2N3f3d6engine16plugin_exception16plugin_exceptionERKNSt6stringE"></span><span id="f3d::engine::plugin_exception::plugin_exception__ssCR"></span><span class="target" id="structf3d_1_1engine_1_1plugin__exception_1a912959867189cd1c31a315af92278119"></span><span class="k"><span class="pre">explicit</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">plugin_exception</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">what</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">&quot;&quot;</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3f3d6engine16plugin_exception16plugin_exceptionERKNSt6stringE" title="Permalink to this definition">#</a><br /></dt>
<dd></dd></dl>

</div>
</dd></dl>

<dl class="cpp struct">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine17readerInformationE">
<span id="_CPPv3N3f3d6engine17readerInformationE"></span><span id="_CPPv2N3f3d6engine17readerInformationE"></span><span id="f3d::engine::readerInformation"></span><span class="target" id="structf3d_1_1engine_1_1readerInformation"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">readerInformation</span></span></span><a class="headerlink" href="#_CPPv4N3f3d6engine17readerInformationE" title="Permalink to this definition">#</a><br /></dt>
<dd><p>A structure providing information about a reader. Returned in a vector by <a class="reference internal" href="#classf3d_1_1engine_1aaf69c1661ba19ff28bb45eb3332841c3"><span class="std std-ref">getReadersInfo()</span></a>. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine17readerInformation4NameE">
<span id="_CPPv3N3f3d6engine17readerInformation4NameE"></span><span id="_CPPv2N3f3d6engine17readerInformation4NameE"></span><span id="f3d::engine::readerInformation::Name__ss"></span><span class="target" id="structf3d_1_1engine_1_1readerInformation_1a30aac8488fbed9ef92fba2bba859263a"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Name</span></span></span><a class="headerlink" href="#_CPPv4N3f3d6engine17readerInformation4NameE" title="Permalink to this definition">#</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine17readerInformation11DescriptionE">
<span id="_CPPv3N3f3d6engine17readerInformation11DescriptionE"></span><span id="_CPPv2N3f3d6engine17readerInformation11DescriptionE"></span><span id="f3d::engine::readerInformation::Description__ss"></span><span class="target" id="structf3d_1_1engine_1_1readerInformation_1a8cd967fb8400bcafb84fac1aff4bc0af"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Description</span></span></span><a class="headerlink" href="#_CPPv4N3f3d6engine17readerInformation11DescriptionE" title="Permalink to this definition">#</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine17readerInformation10ExtensionsE">
<span id="_CPPv3N3f3d6engine17readerInformation10ExtensionsE"></span><span id="_CPPv2N3f3d6engine17readerInformation10ExtensionsE"></span><span id="f3d::engine::readerInformation::Extensions__std::vector:ss:"></span><span class="target" id="structf3d_1_1engine_1_1readerInformation_1a9e778db98dc3a41875ed9c2caeaf3517"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre">&lt;</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Extensions</span></span></span><a class="headerlink" href="#_CPPv4N3f3d6engine17readerInformation10ExtensionsE" title="Permalink to this definition">#</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine17readerInformation9MimeTypesE">
<span id="_CPPv3N3f3d6engine17readerInformation9MimeTypesE"></span><span id="_CPPv2N3f3d6engine17readerInformation9MimeTypesE"></span><span id="f3d::engine::readerInformation::MimeTypes__std::vector:ss:"></span><span class="target" id="structf3d_1_1engine_1_1readerInformation_1aac8ec25ca07da4cafd1f8a157d583f27"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre">&lt;</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">MimeTypes</span></span></span><a class="headerlink" href="#_CPPv4N3f3d6engine17readerInformation9MimeTypesE" title="Permalink to this definition">#</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine17readerInformation10PluginNameE">
<span id="_CPPv3N3f3d6engine17readerInformation10PluginNameE"></span><span id="_CPPv2N3f3d6engine17readerInformation10PluginNameE"></span><span id="f3d::engine::readerInformation::PluginName__ss"></span><span class="target" id="structf3d_1_1engine_1_1readerInformation_1a9d938bd142eb2feb3ac72f6c07eafb6b"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PluginName</span></span></span><a class="headerlink" href="#_CPPv4N3f3d6engine17readerInformation10PluginNameE" title="Permalink to this definition">#</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine17readerInformation14HasSceneReaderE">
<span id="_CPPv3N3f3d6engine17readerInformation14HasSceneReaderE"></span><span id="_CPPv2N3f3d6engine17readerInformation14HasSceneReaderE"></span><span id="f3d::engine::readerInformation::HasSceneReader__b"></span><span class="target" id="structf3d_1_1engine_1_1readerInformation_1ac0dc89d52c535db198c513fb0543755e"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">HasSceneReader</span></span></span><a class="headerlink" href="#_CPPv4N3f3d6engine17readerInformation14HasSceneReaderE" title="Permalink to this definition">#</a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N3f3d6engine17readerInformation17HasGeometryReaderE">
<span id="_CPPv3N3f3d6engine17readerInformation17HasGeometryReaderE"></span><span id="_CPPv2N3f3d6engine17readerInformation17HasGeometryReaderE"></span><span id="f3d::engine::readerInformation::HasGeometryReader__b"></span><span class="target" id="structf3d_1_1engine_1_1readerInformation_1a63da7048de227a690590703369523aa3"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">HasGeometryReader</span></span></span><a class="headerlink" href="#_CPPv4N3f3d6engine17readerInformation17HasGeometryReaderE" title="Permalink to this definition">#</a><br /></dt>
<dd></dd></dl>

</div>
</dd></dl>

</dd></dl>

</section>
</section>


                </article>
              

              
              
                <footer class="bd-footer-article">
                  <!-- Previous / next buttons -->
<div class="prev-next-area">
    <a class="left-prev"
       href="classf3d_1_1context.html"
       title="previous page">
      <i class="fa-solid fa-angle-left"></i>
      <div class="prev-next-info">
        <p class="prev-next-subtitle">previous</p>
        <p class="prev-next-title">Class context</p>
      </div>
    </a>
    <a class="right-next"
       href="class_structf3d_1_1exception.html"
       title="next page">
      <div class="prev-next-info">
        <p class="prev-next-subtitle">next</p>
        <p class="prev-next-title">Class exception</p>
      </div>
      <i class="fa-solid fa-angle-right"></i>
    </a>
</div>
                </footer>
              
            </div>
            
            
              
                <div class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">

  <div class="sidebar-secondary-item">
  <div class="page-toc tocsection onthispage">
    <i class="fa-solid fa-list"></i> Contents
  </div>
  <nav class="bd-toc-nav page-toc">
    <ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#nested-relationships">Nested Relationships</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#nested-types">Nested Types</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#class-documentation">Class Documentation</a></li>
</ul>
  </nav></div>

</div></div>
              
            
          </div>
          <footer class="bd-footer-content">
            <div class="bd-footer-content__inner">
<div class="bd-footer-content__inner container">
  
  <div class="footer-item">
    
<p class="component-author">
By Michael Migliore and Mathieu Westphal
</p>

  </div>
  
  <div class="footer-item">
    
  <p class="copyright">
    
      © Copyright 2024, Michael Migliore and Mathieu Westphal.
      <br/>
    
  </p>

  </div>
  
  <div class="footer-item">
    
  </div>
  
  <div class="footer-item">
    
  </div>
  
</div></div>
          </footer>
        

      </main>
    </div>
  </div>
  
  <!-- Scripts loaded after <body> so the DOM is not blocked -->
  <script src="../_static/scripts/bootstrap.js?digest=12da95d707ffb74b382d"></script>
<script src="../_static/scripts/pydata-sphinx-theme.js?digest=12da95d707ffb74b382d"></script>

  <footer class="bd-footer">
  </footer>
  </body>
</html>